home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / asmutil / alib10.zip / ALIB1.DOC < prev    next >
Text File  |  1994-04-14  |  8KB  |  202 lines
  1.         
  2.                             ALIB Version 1.0
  3.                            ==================
  4.                Copyright (C) 1994 Owens Consulting and
  5.                          Jeff Owens,  04-09-94
  6.                           24551 Metzler Park
  7.                           Estacada, OR 97023
  8.  
  9.                           kowens@teleport.com
  10.                                   
  11.  
  12.         What is it?
  13.         -------------
  14.  
  15.         ALIB is a library of common functions needed by assembly
  16.         language programmers.  Some of the functions included in
  17.         ALIB are:
  18.  
  19.            * Database   * Compression   * Memory Manager
  20.            * Menuing    * Floating Math * Hyper text
  21.            * Windowing  * Hardware analysis
  22.  
  23.  
  24.  
  25.         Why was it written?
  26.         -------------------
  27.  
  28.         For years assembly language has been regarded as somewhat
  29.         tedious and difficult, but its small size, unlimited
  30.         freedom, and performance have kept it very much alive.
  31.         This library attempts to remove some of the tedium by
  32.         adding a set of high level functions to the programmers
  33.         arsenal.  With ALIB it is possible to write DOS programs
  34.         in a few minutes.
  35.  
  36.  
  37.         What hardware and software is needed?
  38.         -------------------------------------
  39.  
  40.         For use with IBM PS/2, XT, PC and compatibles with DOS 2.1
  41.         or greater capability.  The following software will be
  42.         needed to make use of ALIB:
  43.  
  44.         1.  Assembler for 8088,8086,80386, etc.  Known assemblers
  45.             are:  A86 (Shareware), MASM (Microsoft), TASM
  46.             (Borland), OPTASM (SLR Systems).
  47.  
  48.         2.  Linker to handle the .OBJ file produced by
  49.             the assembler.  Linkers are usually sold
  50.             with the assembler except in the case of
  51.             A86.
  52.  
  53.         3.  Debugger for testing.  Many assemblers have
  54.             a companion debugger which is sold separately.
  55.             All of these debuggers are adequate.  The
  56.             old standby DOS DEBUG program will work, but
  57.             it needs symbolic capability for serious
  58.             work.  The independently produced Periscope
  59.             debuggers are also very good.
  60.             
  61.  
  62.         How do I install it?
  63.         --------------------
  64.  
  65.         To initially explore ALIB it is best to place it in a
  66.         separate directory and work with it there.  No special
  67.         installation process is necessary.  Eventually, the
  68.         library itself (ALIB.LIB) can be placed in a common
  69.         directory of assembly tools and the remaining files
  70.         archived.
  71.  
  72.         What files make up ALIB?
  73.         ------------------------
  74.     
  75.         ALIB.LIB         Library of functions
  76.         ALIB1.DOC        General information
  77.         ALIB2.DOC        Summary of library functions 
  78.         ALIB3.DOC        Detailed description of library functions
  79.         TEMPLATE.ASM     Sample format for most programs
  80.         COMMON.INC       Inputs for sample programs
  81.         MAC.INC          Macros for sample programs
  82.         LOAN.ASM         Sample program, computes loan parameters
  83.         LOAN.EXE
  84.         COMPRES.ASM      Sample program, compress a file
  85.         COMPRES.EXE
  86.         RESTOR.ASM       Sample program, uncompress a file
  87.         RESTOR.EXE
  88.         EDREC.ASM        Sample program & library utility (see file)
  89.         EDREC.EXE        
  90.         HYPER.ASM        Sample program to demonstrate hyper text
  91.         HYPER.DAT        Hyper text data for HYPER.EXE
  92.         HYPER.EXE        Sample program and tutorial
  93.         FILE_ID.DIZ      Short description for BBS usage
  94.  
  95.         What files help with understanding ALIB?
  96.         ----------------------------------------
  97.  
  98.         Assembly language programmers can get started by looking at
  99.         TEMPLATE.ASM and then using ALIB2.DOC, ALIB3.DOC and the sample
  100.         programs as reference maternal.  Novice programmers should probably
  101.         execute the sample program called HYPER and study the material,
  102.         then study the sample programs, starting with TEMPLATE.ASM.  
  103.         
  104.  
  105.         Is registration necessary?
  106.         --------------------------
  107.          
  108.         Registration of ALIB is not required for personal or
  109.         commercial use.  However, ALIB is a shareware product and
  110.         without support will not continue in its development.  Three
  111.         levels of registration are recognized:
  112.  
  113.        1.  Programmers who have the time and interest can register
  114.            by evaluating ALIB and sending their comments to the
  115.            author.  The reward will be a clear conscious and lead
  116.            to an improved ALIB.  The minimum information needed
  117.            is the version reviewed and general impressions.
  118.  
  119.        2. Programmers wanting to keep current can send $20 to
  120.           receive the next update and obtain access to a support
  121.           line.
  122.  
  123.        3. Serious programmers who want to actively assist with
  124.           development should contact the author about adding
  125.           functions, evaluating problems, and obtaining source.
  126.           
  127.          
  128.                   Program and Manual by Jeff Owens
  129.                        Owens Consulting, 24551 Metzler Park
  130.                        Estacada Oregon  97023
  131.          
  132.  
  133.         Can I distribute ALIB to others?
  134.         --------------------------------
  135.  
  136.         You are free to distribute this program, provided that
  137.         neither the program nor this document are changed, and the
  138.         program and this document are kept together.  Only a
  139.         marginal fee may be asked for shipment and handling when
  140.         distributing.  You are not allowed to sell this program.
  141.                  
  142.  
  143.         What if problems occur?
  144.         -----------------------
  145.  
  146.         Problems?  What problems?  After two years of work no
  147.         programmer wants to talk about problems.  But, the truth
  148.         is that problems will occur.  Either the documentation
  149.         will not be adequate, bugs will be found, or necessary
  150.         features will be missing.  The answer to all these
  151.         problems is the same, either discard ALIB or support it.
  152.         My pledge is to support ALIB without any monetary gain as
  153.         long as there is a reasonable interest level. 
  154.  
  155.  
  156.         Legal disclaimer
  157.         ---------------
  158.       
  159.         THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  160.         KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  161.         LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  162.         FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO
  163.         THE QUALITY AND PERFORMANCE OF THE PRODUCT IS WITH YOU.
  164.         SHOULD THE PRODUCT PROVE DEFECTIVE, YOU ASSUME THE COST OF
  165.         ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  166.  
  167.         IN NO EVENT WILL OWENS CONSULTING, OR ANY OTHER PARTY WHO
  168.         MAY HAVE REDISTRIBUTED THE PRODUCT AS PERMITTED ABOVE, BE
  169.         LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  170.         INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
  171.         OR INABILITY TO USE THE PRODUCT (INCLUDING BUT NOT LIMITED
  172.         TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
  173.         LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
  174.         THE PRODUCT TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
  175.         SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
  176.         POSSIBILITY OF SUCH DAMAGES.
  177.  
  178.  
  179.  
  180.         Limitations:
  181.         -------------
  182.  
  183.         ALIB is definitely not for everyone.  If you are interested in
  184.         graphic screens, buttons, etc. then look elsewhere.  This
  185.         library is not for graphic applications.  On the other
  186.         hand, lack of graphics greatly increases compatibility,
  187.         speed, and reduces code size.
  188.  
  189.         ALIB is not designed to be accessed from other languages.
  190.         It is possible, but not advised.  The use of registers,
  191.         memory, and display all are designed as if ALIB is the
  192.         main program.
  193.  
  194.         ALIB is not designed for use with TSR (Terminate and
  195.         Stay Resident) programs.  Most of the f